DOCSP-47071: Extended JSON #268
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-php-library ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| ) | ||
|
|
||
| Additional Information |
There was a problem hiding this comment.
This link to extended JSON is mentioned under Extended JSON formats, maybe make the main header here just API Documentation?
mcmorisi
requested changes
Jun 11, 2025
Comment on lines
+33
to
+53
| Extended JSON Formats | ||
| --------------------- | ||
|
|
||
| MongoDB Extended JSON features two string formats to represent BSON data. | ||
| Each format conforms to the `JSON RFC <https://www.rfc-editor.org/rfc/rfc8259>`__ | ||
| and meets specific use cases. | ||
|
|
||
| The following table describes each Extended JSON format: | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :stub-columns: 1 | ||
| :widths: 10 40 | ||
|
|
||
| * - Name | ||
| - Description | ||
|
|
||
| * - **Canonical** or **Extended** | ||
| - | A string format that avoids loss of BSON type information during data conversions. | ||
| | This format prioritizes type preservation at the loss of human-readability and | ||
| interoperability with older formats. |
There was a problem hiding this comment.
FYA, I went and made a sharedinclude for a lot of this boilerplate – see the C# Extended JSON page for an example.
There was a problem hiding this comment.
Since the shell extended json format doesn't apply here, I won't use the sharedinclude
| Extended JSON Examples | ||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following example shows a document containing an ObjectId, date, and long |
There was a problem hiding this comment.
Outside the scope of this issue, but looks like how we format ObjectId isn't consistent in the PHP docs (do we monospace it or not?). Just a callout, don't need to take action on this.
There was a problem hiding this comment.
looks like we mostly monospace it throughout the repos so I'll update!
norareidy
added a commit
that referenced
this pull request
Jul 9, 2025
* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]>
norareidy
added a commit
that referenced
this pull request
Jul 9, 2025
* Add redirects workflow * DOCSP-47058: Shift TOC (#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (#274) * DOCSP-50753: agg tutorial link (#275) * DOCSP-47063: Logging (#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512)
norareidy
added a commit
to norareidy/docs-php-library
that referenced
this pull request
Jul 9, 2025
* Add redirects workflow * DOCSP-47058: Shift TOC (mongodb#251) * DOCSP-47058: Shift TOC * edits * issues and help, edits * fix errors * redirects * landing * RR feedback * RR feedback 2 * fix gh action * DOCSP-47057: Network compression (mongodb#254) * DOCSP-47057: Network compression * delete * edits * MM feedback * DOCSP-47055: Collation (mongodb#258) * DOCSP-47055: Collation * add to each page * edit * edits * list format * SA feedback * DOCSP-47060: Causal consistency (mongodb#261) * DOCSP-47060: Causal consistency * edits * Fix phpcs workflow * First fixes * Fix trailing commas * Fix string quoting * Fix whitespace errors * Fix use statements * Exclude sniff that would break comments * Fix multiline function declarations * Fix wrong array indentation * Fix snake_case variable names * Remove more false-positive errors * Fix control structure spacing * Fix arrays * Use property promotion * Simplify multiline array rules * Check code formatting (mongodb#265) * Check code formatting * fix highlighting * DOCSP-47059: Work with BSON (mongodb#263) * DOCSP-47059: Work with BSON * edits * RR feedback * enum ex * feedback * DOCSP-50222: Reorganize auth pages (mongodb#266) * DOCSP-50222: Reorganize auth pages * edits * fix * snooty * DOCSP-47065: Load balancing (mongodb#257) * DOCSP-47065: Load balancing * edit * word * RR feedback * DOCSP-47056: Monitoring (mongodb#260) * DOCSP-47056: Monitoring * fixes * fix * wording * table * widths * SA feedback * PV feedback * DOCSP-47071: Extended JSON (mongodb#268) * DOCSP-47071: Extended JSON * edits * vale * feedback * DOCSP-47072: Client parameters (mongodb#273) * DOCSP-47072: Client parameters * edits * fix * DOCSP-47069: Polling SRV records (mongodb#274) * DOCSP-50753: agg tutorial link (mongodb#275) * DOCSP-47063: Logging (mongodb#267) * DOCSP-47063: Logging * edits * word * feedback * code edit * fix * JT feedback * edit * spacing * gh link * JT feedback 2 * RR feedback * DOCSP-50185: Connection troubleshooting (mongodb#272) * DOCSP-50185: Connection troubleshooting * edits * remove sharedinclude * fix * wording * fix * MM feedback * DOCSP-50220: Break up FAQ (mongodb#276) * DOCSP-50220: Break up FAQ * edits * RM feedback * AB feedback * fix highlight * DOCSP-50960: Install with pie (mongodb#278) * DOCSP-50960: Install with pie * edits * RR feedback * JT feedback * DOCSP-51123: CC edits and cleanup (mongodb#279) * DOCSP-51123: CC edits and cleanup * build * composer * code errors * commas * more phpcs errors * edits * phpcs * code fixes * more phpcs * fix * RR feedback * DOCSP-50772: isView() (mongodb#281) * DOCSP-50772: isView() * fix manual link Co-authored-by: Nora Reidy <[email protected]> --------- Co-authored-by: Nora Reidy <[email protected]> * phpcs * vale * use toc labels/titles * more titles * label * Drop psalm analysis for doc examples * AB feedback * filter * title changes * build errors --------- Co-authored-by: Andreas Braun <[email protected]> Co-authored-by: Rea Rustagi <[email protected]> (cherry picked from commit 70a7512) (cherry picked from commit f11a732)
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47071
Staging Links
Self-Review Checklist